home *** CD-ROM | disk | FTP | other *** search
/ Workbench Design / WB Collection.iso / workbench werkzeuge / icon tools / swazinfo / swazinfo.guide (.txt) < prev    next >
Amigaguide Document  |  1996-04-07  |  19KB  |  393 lines
  1. @DATABASE "SwazInfo"
  2. @NODE MAIN "SwazInfo 1.4 (02.03.94)"
  3.     SwazInfo 1.4    Copyright (C)1992,93 David Swasbrook.
  4.     ============
  5.   @{" Disclaimer         "    LINK Disclaimer    }    Legal information
  6.   @{" Conditions         "    LINK Conditions    }    Shareware information
  7.   @{" Requirements       "    LINK Requirements    }    Whats needed
  8.   @{" Introduction       "    LINK Introduction    }    Introduction to SwazInfo
  9.   @{" How to Install     "    LINK Installation    }    How to install SwazInfo
  10.   @{" Usage              "    LINK Usage    }    How to use SwazInfo
  11.   @{" Locale             "    LINK Locale    }    Locale translation
  12.   @{" Programmers        "    LINK Programmers    }    Programming information
  13.   @{" Special Thanks     "    LINK Thanx    }    Thankyou for your ideas/support
  14.   @{" History            "    LINK History    }    A very brief history of SwazInfo
  15. @ENDNODE
  16. @NODE Disclaimer
  17. Disclaimer
  18. **********
  19.     I hereby reject any liability or responsibility for these or any
  20.     other consequences from the use of SwazInfo whatsoever. This includes,
  21.     but is not limited to, damage to your equipment, to your data,
  22.     personal injuries, financial loss or any other kinds of side effects.
  23.     Although SwazInfo has been tested thoroughly on several different
  24.     machines, I cannot rule out the possibility that SwazInfo
  25.        o is somehow incompatible to your equipment
  26.        o has bugs that show up on your equipment
  27.        o does not do what it is supposed to do on your equipment
  28.     It is your responsibility to take any precautions necessary to
  29.     protect yourself from these or any other effects. I explicitly
  30.     reject any liability or responsibility from the consequences of you
  31.     using SwazInfo
  32.     Swaz.
  33. @ENDNODE
  34. @NODE Conditions "Shareware distribution info..."
  35. Shareware
  36. *********
  37.     SwazInfo is shareware. The program may be freely distributed and
  38.     copied, as long as the following conditions are fulfilled:
  39.        o The sales price must not be higher than the cost of an (empty)
  40.          disk plus a nominal copying fee plus costs for shipping. The total
  41.          price must not be higher than 5 US$.
  42.        o All parts of the program and the documentation must be complete.
  43.          The distribution of single parts or incomplete subsets of the
  44.          original distribution is NOT ALLOWED.
  45.        o SwazInfo or parts of it may not be sold in combination with or
  46.          as part of commercial software.
  47.        o Program and documentation may not be changed in any way.
  48.        o Permission has been given for distribution through Aminet and
  49.          Fred Fish.
  50.        o Exclusive commercial distribution rights have been granted to
  51.          Intangible Assets Manufacturing for use in its @{" Amiga Envoy " LINK AmigaEnvoy }
  52.          peer-to-peer networking product.
  53.     SwazInfo is shareware, this means I request those users, who
  54.     use SwazInfo, to send me the shareware fee of 10 US$ (or any other
  55.     contributions gratefully accepted) to the following address:
  56.     Postal:       David Swasbrook,
  57.                   43 Pickwick Parade,
  58.                   Howick,
  59.                   Auckland,
  60.                   New Zealand.
  61.      
  62.     Internet:     swaz@iconz.co.nz (private)
  63.               or  msd@iconz.co.nz
  64.     Please include the following information in your registration:
  65.        o your name, address (electronic mail addresses preferred)
  66.        o your Amiga model(s)
  67.        o Kickstart and Workbench versions
  68.        o the SwazInfo version number
  69.        o the MultiuserFilesystem version number (if installed)
  70.      I assure you that the information you send me will be treated
  71.     confidentially.
  72.      I will try and inform everybody, who has registered with me as
  73.     described above, when a new version of SwazInfo becomes available.
  74.      If you have sent a shareware donation, if possible, you will receive
  75.     an update through mail (preferably email).
  76.     Thank you very much in advance !
  77. @ENDNODE
  78. @NODE Requirements "Whats needed to run SwazInfo"
  79. Requirements
  80. ************
  81.     The following are required for SwazInfo to run:
  82.       o @{" matrix.library " LINK MxLib} version 23.1789 or higher
  83.       o V39 is required. Will work under V37 through Arexx.
  84.       o For additional features for SwazInfo you can use the
  85.         @{" MultiuserFileSystem " LINK MUFS} version 1.5 or higher.
  86. @ENDNODE
  87. @NODE MxLib "Matrix Library"
  88. MatrixLibrary
  89. *************
  90.     Copyright 
  91.  David Swasbrook, All Rights Reserved.
  92.     o Yet another library to put in your LIBS: drawer.
  93.     o Matrix.library is a development tool which will be used in
  94.       fourthcoming releases of programs I have written.
  95.     o The name "matrix" came from "The Matrix" - The computer system used
  96.       by the TimeLords (Re: Dr Who).
  97. @ENDNODE
  98. @NODE AmigaEnvoy "What is Amiga Envoy?"
  99. Amiga Envoy
  100. ***********
  101.     Intangible Assets Manufacturing uses SwazInfo in its Amiga Envoy
  102.     peer-to-peer networking product.
  103.       Intangible Assets Manufacturing
  104.       828 Ormond Avenue
  105.       Drexel Hill, PA 19026-2604
  106.       USA
  107.       Email: iam@iam.com
  108.     Amiga Envoy is the standard Amiga peer-to-peer networking software
  109.     developed by Commodore's Amiga Networking Group. Its performance,
  110.     user-interface and API are consistent with the philosophy of the
  111.     Amiga Operating System. Amiga Envoy provides a simple messaging
  112.     interface for the easy development of reliable network applications.
  113.     Included applications enable connected Amiga computers to share hard
  114.     disks, CD-ROMs and printers transparently. Third-party applications
  115.     can provide functionality such as electronic mail, remote computer
  116.     access, multi-user databases and multi-player games.
  117.     Envoy is Copyright 
  118.  Commodore Amiga Inc.
  119. @ENDNODE
  120. @NODE MUFS "MultiUserFileSystem"
  121. MultiUserFileSystem
  122. *******************
  123.     Copyright 
  124.  Geert Uytterhoeven, All Rights Reserved.
  125.       You've got an  Amiga  with  Kickstart  2.04  or  higher and several
  126.     people are regularly fooling around with it ... Last week your sister
  127.     deleted your 20MB JPEG collection by  mistake and you don't want this
  128.     to happen again ... 
  129.     Well, here's the answer: MultiUser!
  130.       MultiUser allows you to create a *IX-like environment where several
  131.     users live together in harmony,  unable  to delete each others files,
  132.     unable to read  those  private  love-letters  of  other users ... And
  133.     this even if several  users  are  working  on the machine at the same
  134.     time (on a terminal hooked up to the serial port) ...
  135.       You are the sole  user  of  your computer? Well, make sure it stays
  136.     that way by installing MultiUser! People without a valid login ID and
  137.     password won't be  able  to  access  files you have made private with
  138.     MultiUser. If you make all  files  private (not readable for others),
  139.     the only useful thing they could do, is boot from a floppy ...
  140.       And ... you do not have to reformat your hard drive!
  141. @ENDNODE
  142. @NODE Introduction
  143. Introduction
  144. ************
  145.     SwazInfo replaces workbench's icon information window while still
  146.     retaining all the information and options and providing more
  147.     window but with several enhancements.
  148.     Features added in addition to normal Workbench Information:
  149.       o AppWindow ; Icons may be dropped into the information window
  150.           to load the image or tooltypes.
  151.       o @{" MultiuserFileSystem " LINK MUFS} ; Owner/Group/Other/SetUID protection bits definable
  152.       o Window font is configurable
  153.       o Commodities support
  154.       o Arexx support see @{" arexx " LINK Arexx }.
  155.     See @{" extra features " LINK ExtraFeatures} for more detail on additional features
  156. @ENDNODE
  157. @NODE Installation
  158. Installation
  159. ************
  160.     Double click on the "install" icon.
  161. @ENDNODE
  162. @NODE Usage "How to use SwazInfo"
  163. How To Use SwazInfo
  164. ********************
  165.     When SwazInfo is enabled when you select "Information" from the
  166.     "Icon" menu on Workbench an alternative Information window is
  167.     used (provided the icon type is known).
  168.     Currently only the following workbench object types are supported:
  169.         WBDISK
  170.         WBDRAWER
  171.         WBGARBAGE
  172.         WBPROJECT
  173.         WBTOOL
  174.     Unsupported workbench object types:
  175.         WBDEVICE
  176.         WBKICK
  177.         WBAPPICON
  178.         o These may be provided in a later release of SwazInfo.
  179.     The interface to each of the supported object types has been designed
  180.     to resemble the original workbench information function to simplify
  181.     things, several @{" extra features " LINK ExtraFeatures} have been built in to enhance the
  182.     icon information feature of workbench.
  183.     Configuration
  184.     *************
  185.     To configure SwazInfo either change the tooltypes or command line
  186.     arguments. Supported arguments/tooltypes are:
  187.       Standard Commodity arguments:
  188.         CX_POPKEY
  189.         CX_POPUP
  190.         CX_PRIORITY
  191.       Specific to SwazInfo:
  192.         FONT        - the name and size of the font to use for gadgets.
  193.                       If not specified then the default system front is used.
  194.                       Eg. FONT="topaz 8"
  195.         CENTERED    - If set then when information windows are opened they
  196.                       will start in the center of the display. If not set then
  197.                       the are opened in the top left of the display. The
  198.                       default for this is off.
  199.         TITLEDELAY  - Number of seconds to display messages in the window title
  200.                       before reverting to the normal window title. The default
  201.                       is 3 seconds.
  202.         TOOLS       - This is a list of default tools that are available when
  203.                       the user clicks on the `Common Default Tools' button.
  204.                       (This is alongside the string gadget for the default tool,
  205.                       and will be disabled if no default tools are available).
  206.                       Eg. To add the tool `MyTool' and `AnotherTool' as default
  207.                           tools:
  208.                                    TOOLS="MyTool,AnotherTool"
  209.                       Several default tools are already defined in SwazInfo, they
  210.                       are used if you do not specify a tools list.
  211.                       You can request that you use the internal tools list as well
  212.                       as your list by setting the first character of your list to
  213.                       "+". Eg. TOOLS="+MyTool,AnotherTool"
  214.                       The internal default tools are:
  215.                                   installer,multiview
  216.         NOCHECKOWNER - if this switch is set then there will be no check made to
  217.                       see if the file is modifiable. Default is FALSE.
  218.         DROPACTION  - This sets the action to perform when an icon is dropped in
  219.                       the information window of another icon, but not in the image
  220.                       box or tooltypes listview. Possible values are:
  221.                           ASK, CANCEL, LOADIMAGES, LOADTOOLTYPES, OPENINFORMATION
  222.                       Default is DROPACTION=ASK
  223.         CLIPBOARDUNIT - specified the clipboard unit number to use. Defaults to 0.
  224.         SAVEDIR       - default directory to save images to. Default = Ram:
  225.         LOADDIR       - default directory to load images from. Default = Ram:
  226.         CREATEICONS   - should icons be created when images are saved? Default = NO.
  227.                         If yes, SwazInfo will use the "env:sys/dev_ilbm.info" icon
  228.                         for saved image, if not available then the default type will
  229.                         be used.
  230.         SIZEFORMAT    - using this you can force SwazInfo to display sizes of disks
  231.                         and directories in bytes, kilobytes or megabytes. Default
  232.                         mode is any, and will use bytes for sizes less than 1K,
  233.                         kilobytes for sizes less than 10 megabytes and megabytes for
  234.                         sizes any greater.
  235. @ENDNODE
  236. @NODE ExtraFeatures "Important extra bits..."
  237. Important Additional Features
  238. *****************************
  239.     o Locale support - uses available language catalogs, the english
  240.         locale is built in. See @{" Locale " LINK Locale }
  241.     o Commodities support - can use the commodities exchange to remove,
  242.         or disable SwazInfo.
  243.     o Arexx support - See @{" Arexx " LINK Arexx }.
  244.     o Icons may be dropped into the information window in several places:
  245.         1) If an icon is dropped onto the tool types list then the tool
  246.            types from that icon will be added to the list (any duplicates
  247.            are discarded).
  248.         2) Dropping an icon onto the icon image will load the dropped
  249.            icons image to be used for the icon being edited.
  250.         3) Anywhere else in the window will do a specifiable action
  251.            see @{" DROPACTION " LINK Usage}.
  252.     o Shift-CloseWindow will close all information windows on the same
  253.       screen.
  254.     o Disk information also displays the disk type (eg. DOS0 or DOS1)
  255.     o RWED protection bits may be set for the owner, group and others.
  256.     o @{" MultiuserFileSystem " LINK MUFS} support:
  257.         1) SetUID bit support
  258.         2) Owner/Group of the file is displayed and an alternative
  259.            owner may be chosen (provided you can modify the file).
  260.     o Menu options to cycle through other information windows.
  261.     o If the image does not fit inside the image display box then you
  262.       may scroll around it by using the numeric keypad.
  263.     o Horizontal and vertical flipping of the image
  264.     o The image colors may be remapped. A Choice of 1.3/2.0 color
  265.       remapping or user definable color swapping or replacement.
  266.     o Default icon support.
  267.     o Image highlight mode selectable.
  268. @ENDNODE
  269. @NODE Arexx "How to use SwazInfo via Arexx..."
  270. Arexx
  271. *****
  272.     SwazInfo adds an arexx port to the system named "SWAZINFO" you may
  273.     use the following commands to control certain features:
  274.     QUIT  - will try to remove SwazInfo from the system.
  275.     SHOW  - displays the SwazInfo about window.
  276.     HIDE  - hides the about window.
  277.     FILE  - You specify the filename of the icon to be viewed, you can
  278.             also give a public screen name to open on. You must give the
  279.             full path to the icon.
  280.             Eg. To view the icon named "Workbench:System/Format" send the
  281.                 arexx command string:
  282.                           FILE Workbench:System/Format
  283.                 or using arexx from cli: (don't forget the ")
  284.                   rx ' address SWAZINFO FILE "Workbench:System/Format"
  285.                 To open the window on the public screen named "PubScreen":
  286.                   rx ' address SWAZINFO FILE "-PubScreen Workbench:System/Format"
  287.                   * The "-" is used to indicate the pubscreen name.
  288.     No other arexx commands are currently supported.
  289. @ENDNODE
  290. @NODE Locale "Only the english locale is currently supported..."
  291. Locale Support
  292. **************
  293.     The SwazInfo interface supports locale, the built in language is
  294.     english. Currently the only alternative language is Fran
  295.     Included in the archive is the @{" Catalog Translation file " LINK "swazinfo.cd/MAIN" 0} just in
  296.     case you would like to translate it into your locale.
  297.     Catalog filename    matrix/swazinfo.catalog
  298. @ENDNODE
  299. @NODE Thanx "List of contributors"
  300. Contributors
  301. ************
  302.     Thank you to the following translators:
  303.       fran
  304. ais  - Jean-Michel Bezeau
  305.     Thank you to the following who have sent in suggestions and
  306.     requests:
  307.       Andreas Baum
  308.       Bernhard Seefeld
  309.       James D. Robbins
  310.       Jeff Harrang
  311.       Klaus Alexander Seistrup
  312.       Luke Chastain
  313.       Thomas Hensel
  314.       Walter Jung
  315.     Thanks also to the following who reported bugs:
  316.       Alex Kiesl
  317.       Gunter Piringer
  318.       James Cooper
  319.     Beta testing performed by:
  320.       Daryl Jay
  321.     Also thanks to Osma Ahvenlampi for designing the MagicWB icon.
  322.     o I'm sorry if you have contributed and you name is not in the
  323.       above lists. I try to reply to all email so if you have sent
  324.       me some mail and not received a reply then it is more than
  325.       likely that my mailer sent it to nil: accidentally.
  326. @ENDNODE
  327. @NODE Programmers
  328. Programming Information
  329. ***********************
  330.     This feature has only been added for release 1.3 of SwazInfo.
  331.     o How to find the SwazInfoBase semaphore. @{" See includes. " LINK "SwazInfo.i/MAIN" 0}
  332.        SwazInfo creates a public semaphore named "SwazInfo" with which
  333.        you may interface to the swazinfo/WBInfo() function and/or read
  334.        various fields in the swazinfoBase structure.
  335.        Once you have called ObtainSemaphore() you should increment
  336.        @{" sis_OpenCount " LINK "SwazInfo.i/MAIN" 0} and call ReleaseSemaphore(). This way you can
  337.        safely call SwazInfo/WBInfo() without fear of it going away.
  338.        When you have finished with it, please decrement @{" sis_OpenCount " LINK "SwazInfo.i/MAIN" 0}
  339.        inside an ObtainSemaphore()/ReleaseSemaphore() of course.
  340.     o Calling the SwazInfo/WBInfo() function
  341.        This has identical calling parameters as the workbench.library
  342.        WBInfo() function.
  343.         worked = WBInfo(lock, name, screen)
  344.           d0             a0    a1     a2
  345. @ENDNODE
  346. @NODE History
  347. History Information
  348. *******************
  349. `1.4'    o Release version for distribution with Amiga Envoy.
  350.     o Finally tracked down bug with the highlight menu items.
  351.     o Remap button added to remap requestor.
  352. `1.3'    o Can load iff brushes for the icon image
  353.     o Can copy/paste images from the clipboard
  354.     o Sorting takes into account disabled tooltypes
  355.     o Semaphore has been made public
  356.     o Exclusive commercial distribution rights have been granted to
  357.       Intangible Assets Manufacturing.
  358.     o Interface layout for garbage tidied up
  359. `1.2'    o When Icons are dropped outside of either the tooltype
  360.       listview or the image box you are given the choice of
  361.       loading image/tooltypes or to bring up the information on
  362.       this icon.
  363.     o Sub-windows of the main information window are now opened
  364.       initially in the center of the information window.
  365.     o Can turn off file owner checking so will assume that you can
  366.       always modify the file.
  367.     o Now works under Kickstart V37
  368.     o Icon image can be remapped to 1.3/2.0 colors or you may define
  369.       the remapping colors.
  370.     o Also the image can be flipped vertically or horizontally.
  371.     o The image my be of any size. It is no longer clipped to fit
  372.       inside the display box. If too large then only part of the
  373.       image is displayed but it may be scrolled using the numeric
  374.       keypad.
  375.     o Can change icon highlight method
  376.     o Added tooltype enable/disable features
  377. `1.1'    o The common default tool gadget has now been implemented. Have added
  378.       new tooltype argument so you can specify your own default tool
  379.       types.
  380.     o The icon type may now be changed by selecting a menu item.
  381.     o All listviews can be used with up/down arrow keys and return
  382.     o The size of a drawer may be computed by selecting the size gadget
  383.       in the top left corner; This may take a while for large directories
  384.       and currently there is no abort method - although i do plan to build
  385.       one in.
  386.     o About window will open on the same screen as the information window
  387.       it was invoked from - unless it is already displayed.
  388.     o Icon paste menu key is now `V' ; icon copy/paste has still not been
  389.       implemented however :)
  390. `1.0'    o Initial release on Aminet.
  391. @ENDNODE
  392. -------------------------------------------------------------------------------
  393.